home *** CD-ROM | disk | FTP | other *** search
/ Power Utilities / Power Utilities.iso / utility / pro84 / goodtime.man < prev    next >
Encoding:
Text File  |  1992-09-18  |  15.8 KB  |  315 lines
  1.                                        
  2.                                        
  3.                                        
  4.                                  Documentation
  5.                                        
  6.                                       for
  7.                                        
  8.                                        
  9.                                    GOODTIME
  10.                                        
  11.                                  Version 1.20
  12.                                        
  13.                                 Copyright 1992
  14.                                        
  15.                                        
  16.                                       by
  17.                                        
  18.                                Sydney M. Willett
  19.                                        
  20.                               September 19, 1992
  21.                                        
  22.                                        
  23.                                        
  24. 1.  GENERAL.
  25.  
  26.     a.  GOODTIME is a program that automatically corrects the timing error  of
  27. the  CMOS  clock.  GOODTIME will set the system (DOS) and CMOS clocks  to  the
  28. correct  time whenever it is executed.  GOODTIME is not a terminate  and  stay
  29. resident  (TSR) program, so it doesn't use valuable system memory when  it  is
  30. not executing.
  31.  
  32.     b.   GOODTIME runs on IBM AT compatible computers.  It will NOT run on  XT
  33. compatible computers (i.e., 8088 CPUs.) GOODTIME was designed to correct  CMOS
  34. clocks,  which  XT  computers  don't have, and therefore  uses  80286  machine
  35. language  instructions.   The program was tested on  AT  compatible  computers
  36. using  80286,  80386SX,  and 80386 CPUs, with EGA,  VGA,  and  SVGA  monitors.
  37. Though not tested on a 80486 computer, the program should work fine with  this
  38. CPU.  Also, the program is not dependent on the monitor type, so it should run
  39. on  computers with other types of monitors.  The program requires less than 64
  40. KB of memory to run.  GOODTIME runs best from a hard disk, but will run from a
  41. floppy.   However, all of the forgoing is not a guarantee that  GOODTIME  will
  42. run on every AT compatible computer.  To the contrary, I'm certain there is at
  43. least  one AT "compatible" computer in the world that will burp while  running
  44. GOODTIME.
  45.  
  46.     c.   Turbo  C  version  2.0 was used to create GOODTIME.   Turbo  C  is  a
  47. trademark of Borland International.
  48.  
  49.  
  50. 2.  DISTRIBUTION POLICY.
  51.  
  52.     a.   GOODTIME is hereby freely given to the Public Domain.   A  SMALL  and
  53. REASONABLE  fee may be charged by user groups for non-profit reimbursement  of
  54. materials, handling, and distribution costs.
  55.  
  56.     b.   GOODTIME is released "as is" with no implied warranty or  guarantees.
  57. The  author  assumes no responsibility for any claims of damage incurred  with
  58. the  use  of  this  program.   Using the program implies  consent  with  these
  59. conditions.
  60.  
  61.     c.   GOODTIME is to be distributed with the executable file (GOODTIME.COM)
  62. and this manual (GOODTIME.MAN).
  63.  
  64.  
  65. 3.  OPERATION.
  66.  
  67.    a.  Overview.
  68.  
  69.         (1)   GOODTIME corrects CMOS errors.  The program does this by knowing
  70. how  many  seconds are lost or gained in a certain period of time.  With  that
  71. information,  the  program determines a timing error ratio  and  applies  that
  72. ratio  to  the  time  elapsed since the last time the  computers  clocks  were
  73. corrected.  If the calculation results in an error of one second or more,  the
  74. computer's clocks will be corrected, and the data file updated to reflect  the
  75. latest  date and time the clocks were corrected.  Using this method means  the
  76. computer's clocks are corrected only when GOODTIME is executed.  This  is  why
  77. it  is  recommended a line be added to the AUTOEXEC.BAT file calling  GOODTIME
  78. once GOODTIME has determined the timing error.
  79.  
  80.         (2)   Phases  of Operation.  GOODTIME has three sequential  phases  of
  81. operation  depending  on where it is in its calculation  of  the  CMOS  timing
  82. error.   The  program operates differently according to its current  phase  of
  83. operation.
  84.  
  85.             (a)  Phase 1 - This is the state when GOODTIME is first loaded  on
  86. your  system.   The program has not begun calculating the CMOS  timing  error.
  87. The  distinguishing feature of this phase is there is no data file.  Automatic
  88. updates of the time is not possible during this phase.
  89.  
  90.             (b)   Phase 2 - In this phase, GOODTIME has begun calculating  the
  91. CMOS  timing  error.   You have given the program a reference  date  and  time
  92. either  interactively or through the command line.  A data  file  exists,  but
  93. contains  only information related to this phase.  It is recommended you  wait
  94. at  least  one  week before executing GOODTIME again.  This will allow  enough
  95. time  to  elapse  for  the  program to calculate the CMOS  timing  error  with
  96. reasonable  accuracy.  The longer you wait between phases 1 and  2,  the  more
  97. accurate  the calculated timing error will be.  Automatic updates of the  time
  98. is not possible during this phase.
  99.  
  100.             (c)   Phase 3 - This is final phase of GOODTIME.  The program  has
  101. determined  the CMOS timing error and has stored the error ratio in  the  data
  102. file.   This phase is achieved after a period of time has elapsed since  phase
  103. 2,  and  culminated  with you entering the correct date and  time.   With  the
  104. reference  date and time stored previously in the data file by  phase  2,  the
  105. current date and time of the computer, and the correct date and time you  have
  106. just  entered, GOODTIME calculates the CMOS timing error.  A new data file  is
  107. then  written  with  the  error ratio.  Thereafter,  every  time  GOODTIME  is
  108. executed, the program will automatically determined how many seconds to add to
  109. or  subtract from the current time to correct for the CMOS timing  error,  and
  110. update the data file with the last time the computer clocks were corrected.
  111.  
  112.         (3)   GOODTIME has many commands that can be entered at the DOS prompt
  113. affecting   the  program's  operation.   Many  commands  operate   differently
  114. depending  on  the  current phase.  GOODTIME allows  you  to  enter  the  date
  115. (mm/dd/yyyy)  and/or  time  (hh:mm:ss)  from  the  DOS  prompt  as   well   as
  116. interactively.  You can also add or subtract seconds (+|-secs) to or from  the
  117. current  time.   Additionally, it has commands  that:  delete  the  data  file
  118. (CLEANUP), effectively resetting GOODTIME to phase 1; display the contents  of
  119. the  data file (DATA); display the date and time (NOW); manually set the  CMOS
  120. timing error (SET); update the data file with the current system date and time
  121. (UPDATE); and display a help screen (?).  The date and time commands  are  the
  122. only  commands that can be used together.  All other commands must be used  be
  123. used singularly.  All of the commands are explained in detail in paragraph  3c
  124. below.
  125.  
  126.    b.  Commands - Summary.
  127.  
  128.     GOODTIME [date] [time] [+|-secs] [CLEANUP] [DATA] [NOW] [SET] [UPDATE] [?]
  129.  
  130.     date    - mm/dd/yyyy  set DOS and CMOS month/day/year
  131.     time    - hh:mm:ss    set DOS and CMOS 24 hour time
  132.     +secs   - add secs to the current time
  133.     -secs   - subtract seconds from the current time
  134.     CLEANUP - remove the data file
  135.     DATA    - show current phase, latest update date and time, and clock error
  136.     NOW     - show current date and time
  137.     SET     - manually set the clock error
  138.     UPDATE  - update the data file with the current date and time
  139.     ?       - display this help message
  140.  
  141.    c.  Commands - Detailed.
  142.  
  143.        (1)  No Commands.
  144.  
  145.             (a)  Phase 1.  GOODTIME assumes you want to begin calculating  the
  146. CMOS timing error by establishing a reference date and time.  The program will
  147. first  display an information screen.  Then you will be prompted to enter  the
  148. correct date and time.  Pressing ESCape in either of those screens will  abort
  149. the  operation.  After you have entered the correct date and time (or used the
  150. current  computer's date and/or time), GOODTIME will set the CMOS  and  system
  151. clocks and create a data file containing the date and time.  GOODTIME will  be
  152. in phase 2 after the data file is created.
  153.  
  154.             (b)  Phase 2.  GOODTIME assumes you want to finish calculating the
  155. CMOS timing error.  The program will display an information screen.  After you
  156. press a key, you'll be prompted to enter the correct date and time.  When  the
  157. correct  date and time is entered (or the current computer's date and/or  time
  158. is  used), GOODTIME will set the CMOS and system clocks.  Once the clocks  are
  159. set, the program will calculate the differences between the reference date and
  160. time entered during phase 1, and the current and correct dates and times.  The
  161. difference  between the current and correct dates and times is  the  error  in
  162. seconds  that  occurred  during the elapsed time  between  the  reference  and
  163. correct date and times.  The data file will be replaced with the correct  date
  164. and time, and the number of seconds gained or lost during an elapsed number of
  165. seconds.   GOODTIME will be in its third and final phase after  these  actions
  166. are completed.
  167.  
  168.             (c)  Phase 3.  This is the third and final phase of operation  for
  169. GOODTIME.  The program will automatically correct any clock errors of  one  or
  170. more seconds.
  171.  
  172.        (2)  date - mm/dd/yyyy  set DOS and CMOS month/day/year
  173.  
  174.             (a)  Phase 1.  GOODTIME assumes you want to begin calculating  the
  175. CMOS  timing  error  by  establishing a reference date  and  time  (using  the
  176. supplied  date but the current time.)  A data file will be created  containing
  177. the reference date and time.  The time command can be used in conjunction with
  178. this command.  GOODTIME will be in phase 2 after the data file is created.
  179.  
  180.             (b)  Phase 2.  GOODTIME uses the supplied date and current time to
  181. compute  the CMOS timing error.  The data file will be updated with  the  date
  182. and  time, as well as the CMOS timing error.  The time command can be used  in
  183. conjunction with this command.  GOODTIME will be in its third and final  phase
  184. after these actions are completed.
  185.  
  186.             (c)   Phase 3.  The date will be changed and the data file updated
  187. with  the  new  date  and  current time.  The time  command  can  be  used  in
  188. conjunction with this command.
  189.  
  190.        (3)  time - hh:mm:ss    set DOS and CMOS 24 hour time
  191.  
  192.             (a)  Phase 1.  GOODTIME assumes you want to begin calculating  the
  193. CMOS  timing  error  by  establishing a reference date  and  time  (using  the
  194. supplied  time but the current date.)  A data file will be created  containing
  195. the reference date and time.  The date command can be used in conjunction with
  196. this command.  GOODTIME will be in phase 2 after the data file is created.
  197.  
  198.             (b)  Phase 2.  GOODTIME uses the supplied time and current date to
  199. compute  the CMOS timing error.  The data file will be updated with  the  date
  200. and  time, as well as the CMOS timing error.  The date command can be used  in
  201. conjunction with this command.  GOODTIME will be in its third and final  phase
  202. after these actions are completed.
  203.  
  204.             (c)   Phase 3.  The time will be changed and the data file updated
  205. with  the  new  time  and  current date.  The date  command  can  be  used  in
  206. conjunction with this command.
  207.  
  208.        (4)  +secs - add seconds to the current time
  209.  
  210.             (a)  Phase 1.  Adds the specified number of seconds to the current
  211. time.  A data file is not created.
  212.  
  213.             (b)   Phase  2.   Will not work while GOODTIME is  in  this  phase
  214. because  this command will invalidate the CMOS timing error test  that  is  in
  215. progress.
  216.  
  217.             (c)  Phase 3.  Adds the specified number of seconds to the current
  218. time.  The data file is updated with the current date and time.
  219.  
  220.        (5)  -secs - subtract seconds from the current time
  221.  
  222.             (a)  Phase 1.  Subtracts the specified number of seconds from  the
  223. current time.  A data file is not created.
  224.  
  225.             (b)   Phase  2.   Will not work while GOODTIME is  in  this  phase
  226. because  this command will invalidate the CMOS timing error test  that  is  in
  227. process.
  228.  
  229.             (c)  Phase 3.  Subtracts the specified number of seconds from  the
  230. current time.  The data file is updated with the current date and time.
  231.  
  232.        (6)  CLEANUP - remove the data file
  233.  
  234.             (a)   Phase  1.   Will not work while GOODTIME is  in  this  phase
  235. because there isn't a data file to delete.
  236.  
  237.             (b)   Phases  2 and 3.  Will delete the data file after  the  user
  238. confirms the command.  This command effectively resets GOODTIME to phase 1.
  239.  
  240.         (7)  DATA - show current phase, latest update date and time, and clock
  241. error
  242.  
  243.             (a)   Phase  1.   Will not work while GOODTIME is  in  this  phase
  244. because there isn't any data to display.
  245.  
  246.            (b)  Phase 2.  Displays the reference date and time.
  247.  
  248.             (c)  Phase 3.  Displays the last date and time the CMOS and system
  249. clocks  were updated, the number of seconds error in a day, and the fractional
  250. number of seconds yet to be updated.
  251.  
  252.        (8)  NOW - show current date and time
  253.  
  254.            (a)  Phase 1, 2, and 3.  Displays the current date and time.
  255.  
  256.        (9)  SET - manually set the clock error
  257.  
  258.             (a)   Phases 1, 2, and 3.  You manually set the CMOS timing error,
  259. bypassing  the  automatic calculation of the CMOS timing error and  proceeding
  260. directly  to  phase 3.  You are first given the choice to set the date  and/or
  261. time, or use the current date and time.  After that, you are prompted to enter
  262. the number of seconds error and the number of hours in which the error occurs.
  263. The  numbers  must  be whole numbers, no decimals.  If the number  of  seconds
  264. error  is not a whole number, use simple math to convert it to a whole  number
  265. by increasing the number of hours in which the error occurs.  An example is if
  266. the CMOS clock loses 4.5 seconds in 24 hours, enter -9 seconds in 48 hours.  A
  267. data file will be written with the date and time and the CMOS timing error you
  268. have just entered.  Pressing ESCape at any prompt will abort the command.
  269.  
  270.        (10)  UPDATE - update the data file with the current date and time
  271.  
  272.             (a)   Phase  1.   Will not work while GOODTIME is  in  this  phase
  273. because there isn't a data file to update.
  274.  
  275.             (b)   Phase  2.   Will not work while GOODTIME is  in  this  phase
  276. because  this command will invalidate the CMOS timing error test  that  is  in
  277. progress.
  278.  
  279.             (c)   Phase  3.  Updates the data file with the current  date  and
  280. time.
  281.  
  282.        (11)  ? - display this help message
  283.  
  284.            (a)  Phases 1, 2, and 3.  Displays a help screen.
  285.  
  286.    d.  Clock Errors That GOODTIME Cannot Correct.
  287.  
  288.        (1)  When the computer is working normally, GOODTIME does a good job of
  289. correcting  the  CMOS  timing error.  However, there are  circumstances  where
  290. GOODTIME  cannot  accurately correct CMOS clock  errors.   When  the  computer
  291. crashes and you are thrown into the CMOS setup screen after boot-up, the  CMOS
  292. clock  invariably loses more time than its established rate.   Simply  stated,
  293. the current time (and possibly date) are incorrect, and GOODTIME has no way of
  294. knowing this.  The only way to recover from this situation is to manually  set
  295. the  date  and time, then update the GOODTIME data file with the correct  date
  296. and time using the UPDATE command.  After this is done, GOODTIME will continue
  297. using  the previously calculated CMOS timing error to keep the CMOS and system
  298. clocks accurate.
  299.  
  300.  
  301. 4.  ADIEU.
  302.  
  303.     a.   I  hope you find GOODTIME useful.  Though not a "must have"  utility,
  304. GOODTIME  does  reduce one source of frustration when using a computer.   I've
  305. been  using  a previous version of GOODTIME on my computer for several  months
  306. and I am satisfied with its performance and capabilities.
  307.  
  308.     b.  If you have any comments or suggestions, you can direct them to me  by
  309. leaving a message to S.WILLETT on GEnie.
  310.  
  311. ____________
  312.  
  313. S.M. WILLETT
  314.  
  315.